package org.rslai.autotest.core.page;

import java.io.IOException;

/**
 * 屏幕截图工具
 * @author rslai
 */
public interface ScreenShot {

	/**
	 * 屏幕截图 (存放到指定目录) <br>
	 * 注意：目前不支持chrome浏览器
	 * @param pathName 指定的目录名
	 * @param prefixFileName 指定的文件名（不包括扩展名）
	 * @return true: 成功
	 */
	public boolean screenShot(String pathName, String prefixFileName) throws IOException;

	/**
	 * 屏幕截图 (存放到指定目录) <br>
	 * 注意：目前不支持chrome浏览器
	 * @param pathName 指定的目录名
	 * @param isTimeStamp 是否在文件名中添加时间戳
	 * @param partFileName 部分文件名（不包括扩展名，而且会自动在前边添加时间戳）
	 * @return true: 成功
	 */
	public boolean screenShot(String pathName, boolean isTimeStamp, String partFileName) throws IOException;

	/**
	 * 屏幕截图 (存放到默认目录) <br>
	 * 路径: report/screenshot/yyyyMMddHHmmss-指定文件名.png <br>
	 * 注意：目前不支持chrome浏览器
	 * @param isTimeStamp 是否在文件名中添加时间戳
	 * @param partFileName 部分文件名（不包括扩展名，而且会自动在前边添加时间戳）
	 * @return true: 成功
	 */
	public boolean screenShot(boolean isTimeStamp, String partFileName) throws IOException;

	/**
	 * 屏幕截图 (存放到默认目录) <br>
	 * 路径: report/screenshot/yyyyMMddHHmmss-指定文件名.png <br>
	 * 注意：目前不支持chrome浏览器
	 * @param partFileName 部分文件名（不包括文件后缀，而且会自动在前边添加时间戳）
	 * @return true: 成功
	 */
	public boolean screenShot(String partFileName) throws IOException;

}
